The Arsenal Files 6/The Arsenal Files 6 (Arsenal Computer).ISO/ra/today028.zip/ONTODAY.DOC

Text File | 1996-03-07 | 23KB | 497 lines

      ┌─
      │  ┌──────┐┌─────┐     ┌───────┐┌──────┐┌─────┐ ┌──────┐┌─┐   ┌─┐
      │  └──────┘└─────┘     └───────┘└──────┘└─────┘ └──────┘└─┘   └─┘
      │  ┌─┐  ┌─┐┌─┐  ┌─┐       ┌─┐   ┌─┐  ┌─┐┌─┐  ┌─┐┌──────┐┌───────┐
      │  │ │  │ ││ │  │ │       │ │   │ │  │ ││ │  │ ││ ┌──┐ │└──┐ ┌──┘
      │  │ └──┘ ││ │  │ │       │ │   │ └──┘ ││ └──┘ ││ │  │ │   │ │
      │  └──────┘└─┘  └─┘       └─┘   └──────┘└──────┘└─┘  └─┘   └─┘
      └─────────────────────────────────────────────────────────── v0.28 ─

                         A 'Who Called Today' Generator
                     (c) Copyright 1994-1996, Dwayne Heaton

             ┌─
             │                       Index
             └───────────────────────────────────────────────────

                                  Introduction

             What is OnToday ? .............................. 1.1
             System Hardware & software requirements ........ 1.2
             Disclaimer and Licensing agreement ............. 1.3

             Installation ................................... 2.0

                                     Usage

             Command Line ................................... 3.1
             The ONTODAY.CTL file ........................... 3.2
             Mailer Support ................................. 3.3

             Bug Reports and Contacting the Author .......... 4.0

             Credits and Thanks ............................. 5.0



┌─
│  1.1  ■  What is OnToday ?
└─────────────────────────────────────────────────────────────────────────────

  OnToday is a 'Todays Callers' ASCII / ANSi / AVATAR bulletin generator with
  a difference.

  It also allows you to export your last BBS caller into your mailer's history
  and produce ASCII / ANSi / AVATAR bulletins of Inbound and/or Outbound mail
  calls.

  It also allows you to export information about fax calls you have received
  into your mailer's history.

  OnToday was written to generate a bulletin of callers to my BBS, allowing
  users to see who has already called the system that day. My BBS software
  (RemoteAccess) already had a facility to do this, but I wanted a different
  layout of the information, and to make new callers stand out from all the
  other users.

  This was the humble beginnings of OnToday..

  Since the first version, I've had many request for additional features.
  These included an export last BBS caller to mailer option, and also an
  export last FAX call to mailer option. So support for FrontDoor and
  InterMail frontend mailers was included, and support for BGFAX was also
  added, including the option to generate bulletins of Today's Inbound and
  Outbound Mail, and todays inbound FAX calls.

  OnToday is written to generate it's bulletins as quickly as possible with
  the minimum of configuring and fiddling by the user.

  And Finally, the program is NOT crippled in any way whatsoever, and
  DOESN'T require any registration fees at all :-)


┌─
│  1.2  ■  System hardware and software requirements
└─────────────────────────────────────────────────────────────────────────────

  ■  An IBM PC, XT, AT or 100% compatible PC with a hard disk.
  ■  Microsoft MS-DOS, IBM PC-DOS or DR-DOS version 3.30 or later. Version
     5.0 or later is recommended.
  ■  At least 128KB of RAM available.

  ■  At the moment OnToday only supports the following BBSes:
       ■ Remote Access    Copyright (c) Wantree Development & Andrew Milner

  ■  OnToday has been successfully tested with Remote Access v2.00, v2.01,
     v2.02 and v2.50g1

  ■  At the moment OnToday only supports the following Mailers:
       ■ FrontDoor        Copyright (c) Joaquim H. Homrighausen
       ■ InterMail        Copyright (c) InterZone Software, Inc

  ■  OnToday has been successfully tested with FrontDoor v2.02, v2.11,
     v2.12, v2.20c.ml and InterMail v2.29c, v2.29f.

  ■  At the moment OnToday only supports the following Fax Programs:
       ■ BGFAX            Copyright (c) B.J. Guillot

  ■  OnToday has been successfully tested with BGFAX v1.47, v1.50.

  ■  OnToday has been successfully tested with MS-DOS 5.0, 6.0, 6.2 and
     6.22, 4DOS 5.0 and 5.5, IBM OS/2 WARP, Novell Netware Lite v1.1,
     Novell Netware v3.12 on systems equiped with Intel/AMD 8086, 80286,
     80386, 80486 and Pentium processors.

  ■  OS/2 is a registered trademark of IBM Corporation
     MS-DOS is a registered trademark of Microsoft Corporation

     All other programs are copyright and/or trademarked by their
     respective author unless otherwise noted.


┌─
│  1.3  ■  Disclaimer and Licensing Agreement
└─────────────────────────────────────────────────────────────────────────────

    ONTODAY consists of all files contained within the distribution archive.
    Before running ONTODAY, you must read and agree to the following
    conditions. If you do not or can not agree to and accept the following
    conditions, you are prohibited from using ONTODAY.

 ■  The documentation and accompanying program are copyrighted material
    designed, produced and tested by the author of the software.

 ■  ONTODAY is distributed as FREEWARE *NOT* Public Domain!

 ■  Since this product is FREEWARE, you are actively encouraged to copy and
    distribute it as long as it remains in its complete form with all support
    and documentation files. No files may be added or taken away from the
    original archived form in which ONTODAY is distributed.

 ■  Shareware vendors and BBSes may redistribute this product as long as they
    do not charge any money or monies for the product. Cost of distribution
    media (be it disk, CD-ROM, tape, etc) and/or subscription charges are
    acceptable.

 ■  I (Dwayne Heaton) am NOT oligated to provide new versions or support for
    ONTODAY.

 ■  In the event that future versions of ONTODAY are released, Dwayne Heaton
    reserves the right not to release them under the FREEWARE concept and to
    charge a nominal fee should it be deemed appropriate.

 ■  Although every care and attention has been taken to write and test the
    program to make sure that it does what this documentation states, the
    program is provided as it is, without warranty or guarantee of any kind,
    either expressed or implied, as to the quality or performance of this
    program, except that it will occupy disk space.

 ■  The author shall not be held liable to you or anyone else for any direct,
    indirect, incidental or consequential damages, including any lost profits,
    lost savings, lost business, which may result from the use or inability
    to use this program.

 ■  You are NOT allowed to do any disassembling, reverse engineering, creating
    patches for ONTODAY and things alike.

 ■  Your use of this program constitutes your agreement to this disclaimer and
    your release of the author from any form of liability or litigation.

 ■  The source code or part of it, is NOT available.

 ■  All rights reserved worldwide.


┌─
│  2.0  ■  Installation
└─────────────────────────────────────────────────────────────────────────────

  Making use of OnToday couldn't be much easier!  Unpack all the files
  in the archive into one directory.

  A new feature of OnToday (as from v0.22) is the ability to configure the
  program to suit your system. An example config file can be created by
  running the SETUP.EXE program. It will be created with default settings.

  The config file ('ONTODAY.CTL') must be in the same directory that you are
  running OnToday from. It doesn't have to exist, but if you want greater
  control over the program, it should (since it gives you more options than
  the command line). The control (config) file is explained in more detail
  in section 3.2, 'The ONTODAY.CTL file'

  You will need to have the RA environment variable set, so that it points
  to your Remote Access system directory, but if you are running RA without
  any problems, this should be already be set  :)

  If you wish to make use of the BGFAX import to mailer facilities you MUST
  have the BGFAX environment variable set (pointing to the BGFAX directory)
  and if you are running in a multi-line system (FD 2.20.ml & IM Multi-line)
  you must have the TASK set to the node number (ie set TASK=2)

  Once you have installed OnToday, you are ready to produce your bulletins.
  The bulletins will be placed in the main Text Files directory as specified
  in your Remote Access configuration file.

  You could run it after every call to the BBS, or you could run it in any
  daily maintenance events.


  NOTE - OnToday will try and use SHARE to open all files it needs. This
         will allow multi-line BBS's to run it without having any problems
         with sharing violations.


┌─
│  3.1  ■  Command Line
└─────────────────────────────────────────────────────────────────────────────

  There are a few command-line options you can use for greater control over
  the program's operation. When used in conjunction with the control file
  these options over-ride any settings in the file.

  If you do not specify any options OnToday will use its internal defaults
  of ignoring HIDDEN users, generating ASCII, ANSi and AVATAR screens,
  excluding the Sysop, using the users real name and automatically detecting
  if you have a colour display, so that it can use the appropriate display
  scheme for its screen.


  ONTODAY -?              Shows a brief help screen with all options listed
                          on it.

          -HELP           Same as above.

          -SYSOP          This will force OnToday to include the Sysop in
                          the bulletin. The Sysop will still be excluded if
                          they are a 'hidden' user, and the '-HIDDEN' option
                          is not specified.

          -HANDLES        This will make OnToday use the handles for users
                          instead of using their real names.

          -HIDDEN         This will tell OnToday to include any user that
                          has been set as 'hidden'
                          (A hidden user is one that has the 'exclude from
                           user list' flag set)

          -NOASCII        Stops OnToday producing the ASCII bulletins

          -NOANSI         Stops OnToday producing the ANSi bulletins

          -NOAVATAR       Stops OnToday producing the AVATAR bulletins


┌─
│  3.2  ■  The ONTODAY.CTL file
└─────────────────────────────────────────────────────────────────────────────

  As said before the control (config) file will allow you to fully configure
  OnToday to your system. It will allow you to set all the options that the
  command line does, but has several more options.

  To create an initial ONTODAY.CTL file or update your existing file to
  this versions options run SETUP.EXE and follow any on-screen instructions

  As of Ontoday v0.28, there is a new version of the setup program. It is
  now fully menu driven, and all options are configurable using it.

  The options can be in any order, and any line starting with a ';' is
  counted as a comment line and isn't processed.

  Here is a list of options you can use, and a description or what they do.

   SystemAddress            This is the address of your system, this is
                            used when importing your last RA caller into
                            your mailer lastcaller. When producing inbound
                            /outbound mail bulletins, any call from this
                            number is ignored.
   Mailer                   This is the mailer you are using. At the moment
                            it only accepts FD202, FD21x, FD220, IM and None.
   RA_To_Mailer_Import      Whether to import your last RA caller into your
                            mailer last caller.
   Fax_To_Mailer_Import     Whether you want your FAX calls imported into
                            your mailer last caller & history log.
   MultiLine                Whether you are running a multiline system.
                            This refers to RemoteAccess. This will add the
                            node (Line) number of the callers in the 'Todays
                            Callers' list.
   IncludeSysop             Whether to include the Sysop in the output, or
                            not. (Even if he/she is also a hidden user)
   IncludeHidden            Include users marked as hidden in the output.
   UseHandles               Use user-handles instead of their real names.
   ASCII                    Whether to produce ASCII output files.
   ANSi                     Whether to produce ANSi output files.
   AVATAR                   Whether to produce AVATAR output files.
   EnterPrompt              Whether to include an enter prompt at the end of
                            each bulletin.
   MaskLocal                Whether to use 'LocalBaud' to mask local
                            logons. If set to no OnToday will use 'LOCAL'
                            as the baud.
   LocalBaud                The masked baud rate to use for local callers.

   Main.Title               The colour 'Todays Callers to ..' is displayed.
   Main.TitleUnderLine      The colour of the line under the above option.
   Main.Header              The colour of the headings line ('Username...')
   Main.HeaderUnderLine     The colour of the line under the above option.

   Caller.Node              The colour of the node the caller logged in on.
                            (This is only used if MultiLine is used)
   Caller.Name              What colour you want the users name/handle to be.
   Caller.Location          This sets the colour the users location is
                            displayed in.
   Caller.TimesCalled       The times the user has called colour
   Caller.BaudRate          The users baud rate, the colour.
   Caller.LogOn             The colour of the Time the user logged on.
   Caller.LogOff            The colour of the Time the user logged off.

   Mail.TimeCalled          The colour of the Time the mail call started
   Mail.SystemName          The colour the System Name will be displayed in.
   Mail.ReceivedBytes       The colour of the bytes recieved (In/Outbound)
   Mail.SentBytes           The colour of the bytes sent (In/Outbound)
   Mail.NodeAddress         The colour the systems node number.

   Fax.SystemName           The colour of the Fax System's name
   Fax.PageCount            The colour of the number of pages received
   Fax.ReceivedBytes        The colour of the number of bytes received
   Fax.Start                The colour of the Time the fax started
   Fax.Finish               The colour of the Time the fax stopped
   Fax.BaudRate             The colour of the fax connect speed.

   ASC_OnToday              The filename of the ASCII Todays Callers bulletin.
   ANS_OnToday              The filename of the ANSi Todays Callers bulletin.
   AVT_OnToday              The filename of the AVATAR Todays Callers bulletin.
   ASC_InBound              The filename of the ASCII Inbound Mail bulletin.
   ANS_InBound              The filename of the ANSi Inbound Mail bulletin.
   AVT_InBound              The filename of the AVATAR Inbound Mail bulletin.
   ASC_OutBound             The filename of the ASCII Outbound Mail bulletin.
   ANS_OutBound             The filename of the ANSi Outbound Mail bulletin.
   AVT_OutBound             The filename of the AVATAR Outbound Mail bulletin.
   ASC_FaxIn                The filename of the ASCII Fax Calls bulletin.
   ANS_FaxIn                The filename of the ANSi Fax Calls bulletin.
   AVT_FaxIn                The filename of the AVATAR Fax Calls bulletin.


  SystemAddress must be a valid 4D mail address. ie 2:252/314.0

  Mailer accepts the following values : FD202, FD21x, FD220, IM, None

  RA_To_Mailer_Import, Fax_To_Mailer, MultiLine, IncludeSysop, IncludeHidden,
  UseHandles, ASCII, ANSi, EnterPrompt and MaskLocal accept the following
  values : Yes or No, On or Off, True or False

  MailerNodes, LocalBaud must be an integer, from 1 to 99999.

  A??_Callers, A??_Inbound, A??_Outbound, A??_FaxIn reconize the following
  values: No, Off, False.  Any thing other these is interpreted as a filename..

  TitleColour, TitleUnderLineColour, HeadingColour, HeadingUnderLineColour,
  NodeColour, NameColour, LocationColour, CalledColour, BaudColour,
  LogOnColour, LogOffColour, MailSystemColour, MailRcvdColour, MailSentColour
  and MailNodeColour accept valid colour names or numbers.

   ╓─────────────── Table of valid colour names and numbers ─────────────────╖
   ╠════╤══════════╗╔════╤══════════════╗╔════╤════════════╗╔════╤═══════════╣
   ║  0 │ Black    ║║  1 │ Blue         ║║  2 │ Green      ║║  3 │ Cyan      ║
   ║  4 │ Red      ║║  5 │ Magenta      ║║  6 │ Brown      ║║  7 │ LightGray ║
   ║  8 │ DarkGray ║║  9 │ LightBlue    ║║ 10 │ LightGreen ║║ 11 │ LightCyan ║
   ║ 12 │ LightRed ║║ 13 │ LightMagenta ║║ 14 │ Yellow     ║║ 15 │ White     ║
   ╠════╧══════════╝╚════╧══════════════╝╚════╧════════════╝╚════╧═══════════╣
   ╙─────────────────────────────────────────────────────────────────────────╜


┌─
│  3.3  ■  Mailer Support
└─────────────────────────────────────────────────────────────────────────────

  If you wish to use OnToday's mailer routines, you must have the appropriate
  control file options enabled, and you must have the environment variable
  for your mailer setup. IM for InterMail and FD for FrontDoor.

  OnToday will allow you to export the last BBS caller (The last BBS caller
  that is listed in the bulletin. ie If the last caller was a user with the
  hidden flag set and you do not include hidden users, OnToday will ignore
  that user, and try and import the last user it didn't ignore into the
  mailer's history file)

  As of v0.26, On Today is fully multi-line aware. It will (with the correct
  option in the control file) display the line number of the user in the
  'Todays Callers' bulletin, and will import the caller into the correct
  mailer history file and last inbound/outbound caller files. This should
  only be used on FrontDoor 2.20ml and multi-line InterMail systems.

  The imported BBS user has the username, baud rate and their location (It
  also adds  [NEW]  for new users)

  example:

  Dwayne Heaton [28800] [NEW]
  Virtual Maddness BBS


  The Inbound/Outbound Mail bulletins
  -----------------------------------

  These display various bits of information about calls to/from your system
  and can be turned off if you so require.

  It includes the Time of the call, the name of the system that was called,
  how many bytes of data were sent and received and the node number of the
  system.

  This was added because some sysops wanted a bulletin to show their users
  why the system was busy, even though there was no users on at the same
  time.

  If you are running FrontDoor 2.20 or InterMail multi-line this bulletin
  will have a page of calls to/from your system for EACH line.


┌─
│  4.0  ■  Bug Reports and Contacting the Author
└─────────────────────────────────────────────────────────────────────────────

  Please contact me if you have any bug reports and/or suggestions for
  improvements to OnToday.

  If you have a bug report, just mail me a filled in REPORT.BUG (this file
  should have been included in the distribution archive) at one of the
  addresses below.

  I'm open to suggestions for support for other BBS or mailer software. If
  you wish this please supply the structure of the userbase (and all
  related files) files (PASCAL is prefered, but I can work with C) of the
  BBS software you wish supported (Also, could you give me a list of
  environment variables it uses, and filenames)

  ie. RA points to the RemoteAccess directory.
         RemoteAccess's configuration file is called 'CONFIG.RA'
      FD points to the Front Door directory.
         Front Door's configuration file is called 'SETUP.FD'
      IM points to the InterMail directory.
         InterMail's configuration file is called 'FD.SYS'

  I cannot guarantee it will be supported in future versions (if any),
  but you never know.

  I can be contacted using a number of different methods:

  Page/Leave a message on my BBS:
   Virtual Maddness -- [phone] -- 24 hours, 300 to 28800 baud

  Send a netmail to me at one of my various AKAs:
   FidoNet    :  2:252/314.0
   RANet      :  73:7441/13.0
   PascalNet  :  115:4401/407.0
   InterNet   :  [e-mail]
                 [e-mail]


┌─
│  5.0  ■  Credits and Thanks
└─────────────────────────────────────────────────────────────────────────────

   Thanks to my beta testers for helping me test my progs and for their
   numerous suggestions, helpful criticism and for the multitude of
   bug reports.

   Thanks to Andrew Pappas, Michael Devonport and Peter Burnett for their
   help with the Multi-Line BBS and Mailer support.

   Thanks to Peter Burnett for help with the InterMail support and with
   supplying various bits of source code.

   Many thanks to Simon Cansick for help with the FrontDoor v2.20ml support.

   Also thanks must go out to all the people who have sent suggestions
   to me (Please keep it up), no names since you know who you are (actually
   the list is too large to be included here)


 Beta Testers
 ============

   Steven Holme         The Fonty Towers BBS      [phone]
                        FidoNet    2:2503/216     [phone]
                                   2:2503/226
                        RANet     73:7444/22

   Peter Burnett        Neverland eXpress         [phone]
                        FidoNet    2:441/80
                        RANet     73:7441/206

   Michael Devonport    Midnite Madness BBS       [phone]
                        FidoNet    2:254/301
                        RANet     73:7441/15

   Simon Cansick        Guru-Ten BBS              [phone]
                        FidoNet    2:250/364      [phone]
                                   2:250/365
                        RANet     73:7448/13


┌─
│                           End of File ONTODAY.DOC
└─────────────────────────────────────────────────────────────────────────────